home *** CD-ROM | disk | FTP | other *** search
/ Best Tools for JAVA / Best Tools for JAVA.iso / JAVA_ALL / IDE / SUBARTIC / SUB_ARCT / INPUT / SELECTAB.JAV < prev    next >
Encoding:
Text File  |  1996-10-04  |  2.2 KB  |  59 lines
  1.  
  2. package sub_arctic.input;
  3.  
  4. /** 
  5.  * Input protocol interface for objects which can be put in a currently 
  6.  * selected set (managed by the selection_agent).  
  7.  *
  8.  * @see sub_arctic.input.selection_agent_class
  9.  * @author Scott Hudson
  10.  */
  11. public interface selectable {
  12.  
  13.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  14.  
  15.   /** 
  16.    * Dispatch input indicating object has been selected.  If this routine 
  17.    * returns false then the selection is considered to be rejected and the 
  18.    * object is not added to the currently selected object set.
  19.    *
  20.    * @param event  evt       the event "causing" the selection.
  21.    * @param Object user_info the information associated with the pick causing 
  22.    *                         the selection.
  23.    * @return boolean indicating whether the input was consumed.
  24.    */
  25.   public boolean select(event evt, Object user_info);
  26.  
  27.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  28.  
  29.   /** 
  30.    * Dispatch input indicating object has been unselected.  The object will
  31.    * be removed from the currently selected object set regardless of the 
  32.    * return value from this routine.
  33.    *
  34.    * @param event  evt       the event "causing" the loss of selection.
  35.    * @param Object user_info the information associated with the pick causing 
  36.    *                         the loss of selection.
  37.    * @return boolean indicating whether the input was consumed.
  38.    */
  39.   public boolean unselect(event evt, Object user_info);
  40.  
  41.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  42. }
  43. /*=========================== COPYRIGHT NOTICE ===========================
  44.  
  45. This file is part of the subArctic user interface toolkit.
  46.  
  47. Copyright (c) 1996 Scott Hudson and Ian Smith
  48. All rights reserved.
  49.  
  50. The subArctic system is freely available for most uses under the terms
  51. and conditions described in 
  52.   http://www.cc.gatech.edu/gvu/ui/sub_arctic/sub_arctic/doc/usage.html 
  53. and appearing in full in the lib/interactor.java source file.
  54.  
  55. The current release and additional information about this software can be 
  56. found starting at: http://www.cc.gatech.edu/gvu/ui/sub_arctic/
  57.  
  58. ========================================================================*/
  59.